<!-- XHTML 1.0 Strict -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<meta name="author" content="Rachid Touzani" />
<meta name="keywords" content=" css, dropdowns, dropdown menu, drop-down, menu, navigation, nav, horizontal, vertical left-to-right, vertical right-to-left, horizontal linear, horizontal upwards, cross browser, internet explorer, ie, firefox, safari, opera, browser, lwis" />
<meta name="description" content="Clean, standards-friendly, modular framework for dropdown menus" />
<link href="../css/dropdown.vertical.css" media="screen" rel="stylesheet" type="text/css" />
<link href="../css/default.ultimate.css" media="screen" rel="stylesheet" type="text/css" />
<head>
<!-- Title -->
<title>OFELI - Documentation</title>
<!-- Stylesheet -->
<link rel="stylesheet" type="text/css" href="../doxygen.css" />
<link rel="stylesheet" type="text/css" href="../tabs.css" />
</head>
<body>
<p align="center">
  <img src="../im/ofeli.gif" alt="OFELI's Logo" width="300" height="90">
</p>
<p align="center"><font color="#203F5B" size="4" face="verdana,Helvetica">
<b>An Object Oriented Finite Element Library</b></font></p>
<!-- Complete Page-->
<div id="main">
<div id="mainmenu">
 <div class="text">
<!-- Menu -->
 <div class="tabs">
  <ul class="tablist">
   <li><a href="../index.html"><span>Home</span></a>
    <li><a href="../overview.html"><span>Overview</span></a>
    <li><a href="../extlib.html"><span>External Libraries</span></a>
    <li><a href="../citing.html"><span>Citing OFELI</span></a>
    <li><a href="../fformats.html"><span>File Formats</span></a>
    <li><a href="../demos.html"><span>Demo Codes</span></a>
  </ul>
 </div>
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classOFELI_1_1Estimator.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classOFELI_1_1Estimator-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">Estimator Class Reference<div class="ingroups"><a class="el" href="group__OFELI.html">OFELI</a> &raquo; <a class="el" href="group__Equation.html">General Purpose Equations</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>To calculate an a posteriori estimator of the solution.  
 <a href="classOFELI_1_1Estimator.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:abb232095ed221e3cc2b045ff79053b51"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abb232095ed221e3cc2b045ff79053b51"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOFELI_1_1Estimator.html#abb232095ed221e3cc2b045ff79053b51">Estimator</a> ()</td></tr>
<tr class="memdesc:abb232095ed221e3cc2b045ff79053b51"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default Constructor. <br /></td></tr>
<tr class="separator:abb232095ed221e3cc2b045ff79053b51"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac75af9393b8c8d81788583aac7f1957c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOFELI_1_1Estimator.html#ac75af9393b8c8d81788583aac7f1957c">Estimator</a> (<a class="el" href="classOFELI_1_1Mesh.html">Mesh</a> &amp;m)</td></tr>
<tr class="memdesc:ac75af9393b8c8d81788583aac7f1957c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor using finite element mesh.  <a href="#ac75af9393b8c8d81788583aac7f1957c">More...</a><br /></td></tr>
<tr class="separator:ac75af9393b8c8d81788583aac7f1957c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a66fefe296cc283f479648d938ba05052"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a66fefe296cc283f479648d938ba05052"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOFELI_1_1Estimator.html#a66fefe296cc283f479648d938ba05052">~Estimator</a> ()</td></tr>
<tr class="memdesc:a66fefe296cc283f479648d938ba05052"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:a66fefe296cc283f479648d938ba05052"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a97ceb23cb630a1d1e445d786bc04edf9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOFELI_1_1Estimator.html#a97ceb23cb630a1d1e445d786bc04edf9">setType</a> (<a class="el" href="classOFELI_1_1Estimator.html#a3d248e8029a03537eb6296f93345f51e">EstimatorType</a> t=<a class="el" href="classOFELI_1_1Estimator.html#a3d248e8029a03537eb6296f93345f51ea7794313b487e60087acd23190b1ef61d">ESTIM_ZZ</a>)</td></tr>
<tr class="memdesc:a97ceb23cb630a1d1e445d786bc04edf9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Select type of a posteriori estimator.  <a href="#a97ceb23cb630a1d1e445d786bc04edf9">More...</a><br /></td></tr>
<tr class="separator:a97ceb23cb630a1d1e445d786bc04edf9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af6fe5bb0ec25b8e2fec7331f7ea33afb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOFELI_1_1Estimator.html#af6fe5bb0ec25b8e2fec7331f7ea33afb">setSolution</a> (const <a class="el" href="classOFELI_1_1Vect.html">Vect</a>&lt; <a class="el" href="group__Util.html#gaccfeb6b1e8cf41731fde610549bee67c">real_t</a> &gt; &amp;u)</td></tr>
<tr class="memdesc:af6fe5bb0ec25b8e2fec7331f7ea33afb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provide solution vector in order to determine error index.  <a href="#af6fe5bb0ec25b8e2fec7331f7ea33afb">More...</a><br /></td></tr>
<tr class="separator:af6fe5bb0ec25b8e2fec7331f7ea33afb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a52f5df03e050b74f199dc6e3b6b47c72"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOFELI_1_1Estimator.html#a52f5df03e050b74f199dc6e3b6b47c72">getElementWiseIndex</a> (<a class="el" href="classOFELI_1_1Vect.html">Vect</a>&lt; <a class="el" href="group__Util.html#gaccfeb6b1e8cf41731fde610549bee67c">real_t</a> &gt; &amp;e)</td></tr>
<tr class="memdesc:a52f5df03e050b74f199dc6e3b6b47c72"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get vector containing elementwise error index.  <a href="#a52f5df03e050b74f199dc6e3b6b47c72">More...</a><br /></td></tr>
<tr class="separator:a52f5df03e050b74f199dc6e3b6b47c72"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a339fd80b6f16ed203804fd6123a568b1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a339fd80b6f16ed203804fd6123a568b1"></a>
<a class="el" href="group__Util.html#gaccfeb6b1e8cf41731fde610549bee67c">real_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOFELI_1_1Estimator.html#a339fd80b6f16ed203804fd6123a568b1">getAverage</a> () const </td></tr>
<tr class="memdesc:a339fd80b6f16ed203804fd6123a568b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return averaged error. <br /></td></tr>
<tr class="separator:a339fd80b6f16ed203804fd6123a568b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a913c6c03741d94f86d65690fd7d5902a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a913c6c03741d94f86d65690fd7d5902a"></a>
<a class="el" href="classOFELI_1_1Mesh.html">Mesh</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOFELI_1_1Estimator.html#a913c6c03741d94f86d65690fd7d5902a">getMesh</a> () const </td></tr>
<tr class="memdesc:a913c6c03741d94f86d65690fd7d5902a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a reference to the finite element mesh. <br /></td></tr>
<tr class="separator:a913c6c03741d94f86d65690fd7d5902a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>To calculate an a posteriori estimator of the solution. </p>
<p>This class enables calculating an estimator of a solution in order to evaluate reliability. Estimation uses the so-called Zienkiewicz-Zhu estimator.</p>
<dl class="section author"><dt>Author</dt><dd>Rachid Touzani </dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>GNU Lesser Public License </dd></dl>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a class="anchor" id="a3d248e8029a03537eb6296f93345f51e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="classOFELI_1_1Estimator.html#a3d248e8029a03537eb6296f93345f51e">EstimatorType</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Enumerate variable that selects an error estimator for mesh adaptation purposes </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="a3d248e8029a03537eb6296f93345f51ea7794313b487e60087acd23190b1ef61d"></a>ESTIM_ZZ&#160;</td><td class="fielddoc">
<p>Zhu-Zienckiewicz elementwise estimator </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a3d248e8029a03537eb6296f93345f51eaca80926339029dc37fa92e00a4341e99"></a>ESTIM_ND_JUMP&#160;</td><td class="fielddoc">
<p>Normal derivative jump sidewise estimator </p>
</td></tr>
</table>

</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ac75af9393b8c8d81788583aac7f1957c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classOFELI_1_1Estimator.html">Estimator</a> </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classOFELI_1_1Mesh.html">Mesh</a> &amp;&#160;</td>
          <td class="paramname"><em>m</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Constructor using finite element mesh. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">m</td><td><a class="el" href="classOFELI_1_1Mesh.html" title="To store and manipulate finite element meshes. ">Mesh</a> instance </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a97ceb23cb630a1d1e445d786bc04edf9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void setType </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classOFELI_1_1Estimator.html#a3d248e8029a03537eb6296f93345f51e">EstimatorType</a>&#160;</td>
          <td class="paramname"><em>t</em> = <code><a class="el" href="classOFELI_1_1Estimator.html#a3d248e8029a03537eb6296f93345f51ea7794313b487e60087acd23190b1ef61d">ESTIM_ZZ</a></code></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Select type of a posteriori estimator. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">t</td><td>Type of estimator. It has to be chosen among the enumerated values: <ul>
<li>
<code>ESTIM_ZZ</code>: The Zhu-Zienckiewicz estimator (Default value) </li>
<li>
<code>ESTIM_ND_JUMP</code>: An estimator based on the jump of normal derivatives of the solution across mesh sides </li>
</ul>
</td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="af6fe5bb0ec25b8e2fec7331f7ea33afb"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void setSolution </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classOFELI_1_1Vect.html">Vect</a>&lt; <a class="el" href="group__Util.html#gaccfeb6b1e8cf41731fde610549bee67c">real_t</a> &gt; &amp;&#160;</td>
          <td class="paramname"><em>u</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Provide solution vector in order to determine error index. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">u</td><td>Vector containing solution at mesh nodes </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a52f5df03e050b74f199dc6e3b6b47c72"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void getElementWiseIndex </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classOFELI_1_1Vect.html">Vect</a>&lt; <a class="el" href="group__Util.html#gaccfeb6b1e8cf41731fde610549bee67c">real_t</a> &gt; &amp;&#160;</td>
          <td class="paramname"><em>e</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get vector containing elementwise error index. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in,out]</td><td class="paramname">e</td><td>Vector that contains once the member function setError is invoked a posteriori estimator at each element </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->

</div> <!-- class text -->
</div> <!-- main menu -->
<!-- Google Search -->
<br><br>
<center>
  <div id="cse" style="width: 80%;">Loading</div>
  <script src="http://www.google.com/jsapi" type="text/javascript"></script>
  <script type="text/javascript"> 
     google.load('search', '1', {language : 'en', style : google.loader.themes.SHINY});
     google.setOnLoadCallback(function() {
        var customSearchOptions = {};  var customSearchControl = new google.search.CustomSearchControl(
        '012396140824982761142:-qrywxcfi_o', customSearchOptions);
        customSearchControl.setResultSetSize(google.search.Search.FILTERED_CSE_RESULTSET);
        customSearchControl.draw('cse');
     }, true);
   </script>
   <style type="text/css">
     .gsc-control-cse {
     font-family: Verdana, sans-serif;
     border-color: #DAE0E5;
     background-color: #DAE0E5;
   }
   .gsc-control-cse .gsc-table-result { font-family: Verdana, sans-serif; }
   input.gsc-input { border-color: #B6BEC5; }
   input.gsc-search-button {
     border-color: #B6BEC5;
     background-color: #D0D1D4;
   }
   .gsc-tabHeader.gsc-tabhInactive {
     border-color: #999999;
     background-color: #EEEEEE;
   }
   .gsc-tabHeader.gsc-tabhActive {
     border-color: #999999;
     background-color: #999999;
   }
   .gsc-tabsArea { border-color: #999999; }
   .gsc-webResult.gsc-result,
   .gsc-results .gsc-imageResult {
     border-color: #FFFFFF;
     background-color: #FFFFFF;
   }
   .gsc-webResult.gsc-result:hover,
   .gsc-imageResult:hover {
     border-color: #D2D6DC;
     background-color: #EDEDED;
   }
   .gsc-webResult.gsc-result.gsc-promotion:hover {
     border-color: #D2D6DC;
     background-color: #EDEDED;
   }
   .gs-webResult.gs-result a.gs-title:link,
   .gs-webResult.gs-result a.gs-title:link b,
   .gs-imageResult a.gs-title:link,
   .gs-imageResult a.gs-title:link b { color: #0568CD; }
   .gs-webResult.gs-result a.gs-title:visited,
   .gs-webResult.gs-result a.gs-title:visited b,
   .gs-imageResult a.gs-title:visited,
   .gs-imageResult a.gs-title:visited b { color: #0568CD; }
   .gs-webResult.gs-result a.gs-title:hover,
   .gs-webResult.gs-result a.gs-title:hover b,
   .gs-imageResult a.gs-title:hover,
   .gs-imageResult a.gs-title:hover b { color: #0568CD; }
   .gs-webResult.gs-result a.gs-title:active,
   .gs-webResult.gs-result a.gs-title:active b,
   .gs-imageResult a.gs-title:active,
   .gs-imageResult a.gs-title:active b { color: #0568CD; }
   .gsc-cursor-page { color: #0568CD; }
   a.gsc-trailing-more-results:link { color: #0568CD; }
   .gs-webResult .gs-snippet,
   .gs-imageResult .gs-snippet,
   .gs-fileFormatType { color: #5F6A73; }
   .gs-webResult div.gs-visibleUrl,
   .gs-imageResult div.gs-visibleUrl { color: #5F6A73; }
   .gs-webResult div.gs-visibleUrl-short { color: #5F6A73; }
   .gs-webResult div.gs-visibleUrl-short { display: none; }
   .gs-webResult div.gs-visibleUrl-long { display: block; }
   .gs-promotion div.gs-visibleUrl-short { display: none; }
   .gs-promotion div.gs-visibleUrl-long { display: block; }
   .gsc-cursor-box { border-color: #FFFFFF; }
   .gsc-results .gsc-cursor-box .gsc-cursor-page {
      border-color: #999999;
      background-color: #FFFFFF;
      color: #0568CD;
   }
   .gsc-results .gsc-cursor-box .gsc-cursor-current-page {
      border-color: #999999;
      background-color: #999999;
      color: #0568CD;
   }
   .gsc-webResult.gsc-result.gsc-promotion {
      border-color: #D2D6DC;
      background-color: #D0D1D4;
   }
   .gsc-completion-title { color: #0568CD; }
   .gsc-completion-snippet { color: #5F6A73; }
   .gs-promotion a.gs-title:link,
   .gs-promotion a.gs-title:link *,
   .gs-promotion .gs-snippet a:link { color: #0066CC; }
   .gs-promotion a.gs-title:visited,
   .gs-promotion a.gs-title:visited *,
   .gs-promotion .gs-snippet a:visited { color: #0066CC; }
   .gs-promotion a.gs-title:hover,
   .gs-promotion a.gs-title:hover *,
   .gs-promotion .gs-snippet a:hover { color: #0066CC; }
   .gs-promotion a.gs-title:active,
   .gs-promotion a.gs-title:active *,
   .gs-promotion .gs-snippet a:active { color: #0066CC; }
   .gs-promotion .gs-snippet,
   .gs-promotion .gs-title .gs-promotion-title-right,
   .gs-promotion .gs-title .gs-promotion-title-right *  { color: #333333; }
   .gs-promotion .gs-visibleUrl,
   .gs-promotion .gs-visibleUrl-short { color: #5F6A73; }
   </style>
</center>
<!-- End of Google Search Box -->
<br><br><br></p>
<div id="foot_bar">
  Copyright &copy; 1998-2019 Rachid Touzani&nbsp;
</div>
</div> <!-- main -->
</body>
</HTML>
